home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 2 / United Public Domain Gold 2.iso / utilities / pu564.dms / pu564.adf / WBM.Manual < prev    next >
Text File  |  1994-11-07  |  19KB  |  600 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                              WorkBenchMate
  8.  
  9.  
  10.                                  v1.15
  11.  
  12.  
  13.                 © 1994 A.O'Connell  All Rights Reserved
  14.  
  15.  
  16.                                SHAREWARE
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30. Introduction
  31. ~~~~~~~~~~~~
  32.  
  33.          WBM started life after getting Blitz Basic 2 from an Amiga Format
  34. coverdisk, Once seeing what this excellent language could do I immediately
  35. ordered my own copy of it, and subscribed to the user magazine, and set
  36. about writing the first experimental version of WBM.
  37.  
  38.          The idea for WBM came from two sources, the first was that a
  39. friend of mine had recently bought an A600 with a hard disk, and found it
  40. increasingly annoying to have to keep clicking though thousands and
  41. thousands of draws to get to the utility/game that he wanted, so I asked
  42. him if he wanted a menu utility to ease the burden. But being the
  43. cheapskate that he is he didn't want to buy one, so he asked me if I would
  44. write one for him. Now the inspiration for the GUI came from looking at a
  45. review of an old commercial utility (that incidentally looked as if it
  46. had been written in CanDO ! :?), anyway I thought, yes that's good, but
  47. I think I could do better. So... After receiving Blitz 2, I started
  48. work on this project.
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.                         HD - Install Users Guide.
  63.                         ~~~~~~~~~~~~~~~~~~~~~~~~~
  64.  
  65.  
  66.         Right, now first of all you will need to install WBM on your hard
  67. disk, or floppy for that matter, now here's an idea why not use the
  68. HD-Installer that I wrote (and you better had to, as it took a b******d
  69. long time to write). OK now when you double click on the HD-Install icon
  70. the following screen will appear:
  71.  
  72.  
  73.  
  74.         +-------------------------------------------------+
  75.         |                                                 |
  76.         |         +-------------------------------+       |
  77.         |         |       WBM - HD Installer      |       |
  78.         |         +-------------------------------+       |
  79.         |                                                 |
  80.         |                                                 |
  81.         |                                                 |
  82.         |  ______________________________    _______      |
  83.         | |_______3______________________|  |___1___|     |
  84.         |                                                 |
  85.         |                                                 |
  86.         |  _________________                              |
  87.         | |_______4_________|                             |
  88.         |                     _______                     |
  89.         |                    |___2___|                    |
  90.         |                                                 |
  91.         +-------------------------------------------------+
  92.  
  93.  
  94.  
  95.    Now then :
  96.  
  97.         1 :     The browse button enables you to choose where you want
  98.                 to install WBM (Note : the install program will create
  99.                 a directory, and copy a draw icon for the directory.)
  100.  
  101.         2 :     This is the button that starts off the installation.
  102.  
  103.         3 :     This is the text box that holds the path that you want
  104.                 WBM installed to (e.g. `Work:Utils/WBM')
  105.  
  106.         4 :     This Holds the root of your boot drive.
  107.                 Now if you booted from your hard drive before you ran
  108.                 HD-Install then you should put SYS: here, if you didn't
  109.                 then Workbench 2.x owners should find their boot drive by
  110.                 holding both mouse buttons down and resetting, then working
  111.                 through to the boot until you find this information out.
  112.  
  113.  
  114.         IMPORTANT NOTE
  115.         ~~~~~~~~~~~~~~
  116.  
  117.         When using the installation program do *NOT* use split names, such
  118.         as "RAM DISK:" or "Workbench 2.x", as the program will not install
  119.         the files properly.
  120.  
  121.  
  122.         See later on for information on how to use split names
  123.         (e.g. `RAM DISK:' or `Workbench 2.x:') within WBM.
  124.  
  125.  
  126.  
  127.         OK now all you need to do is to add the following line to your
  128.         startup-sequence (found in S: dir) before the line that says
  129.         `EndCLI'
  130.  
  131.                 BRun <path to WBM>/WBM
  132.  
  133.            e.g. BRun SYS:Utils/WBM/WBM
  134.  
  135.  
  136. for those of you who whose idea of technical is a wooden spoon, then thing
  137. to do is this....
  138.  
  139.                    Idiots Guide To Installing WBM
  140.                    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  141.  
  142.         1. Remove ALL disks, and reset your Amiga
  143.         2. Your hard-drive will now boot, and WorkBench will appear
  144.         3. Insert this disk, and double click on the disk icon
  145.         4. Now Double click on HD-Install, click on the top text box, and
  146.            type the following line :
  147.  
  148.                         SYS:
  149.  
  150.            now when you press return, it will change to :
  151.  
  152.                         SYS:WBM
  153.  
  154.            and the bottom textbox will change to :
  155.  
  156.  
  157.                         SYS:
  158.  
  159.            if this has happened then all is well with the world, now click
  160.            on the button marked "GO!", and a requester *should* appear,
  161.            saying the following.
  162.  
  163.  
  164.            +-------------------------------------------------+
  165.            |                                                 |
  166.            |             Install To 'SYS:WBM' ?              |
  167.            |                                                 |
  168.            |                                                 |
  169.            | |Yes|                                      |No| |
  170.            +-------------------------------------------------+
  171.  
  172.  
  173.         5. now click on `Yes' and a screen will appear showing you what
  174.            files it is copying, and where it is copying them to.
  175.  
  176.         6. Once it has finished and the main install screen has re-
  177.            appeared quit out, and load the text editor supplied (QED), and
  178.            press <Right Amiga Key> and O, then click on the text box by
  179.            the label `FILE:', and type
  180.  
  181.                     S:startup-sequence
  182.  
  183.         7. Go down to where it says:
  184.  
  185.                 EndCLI
  186.  
  187.            and click on the `E', then press return, and in the line you
  188.            have inserted, type:
  189.  
  190.  
  191.                 BRun SYS:WBM/WBM
  192.  
  193.  
  194.            then press <Right Amiga Key> and W, so it saves it to disk.
  195.  
  196.         8. Now reset your Amiga, and when WorkBench appears, so should
  197.            WBM.
  198.  
  199.         9. Finally, should for any reason you need to stop this, then
  200.            simply put a `;' in front of the `B'.
  201.  
  202.  
  203. Note: For WBM to work correctly when started from CLI it must be BRun'ed
  204.       so, only the version of BRun supplied on disk should be used
  205.  
  206.  
  207.  
  208.                         WBM - Technical Guide
  209.                         ~~~~~~~~~~~~~~~~~~~~~
  210.  
  211.  
  212.         First off don't panic and start looking though the rest of the doc
  213. file to find the standard users guide, 'cos it doesn't exist. Instead use
  214. the two help programs.
  215.  
  216.         For the rest of you, this part of the doc file explains the finer
  217. points of WBM, to give a better understanding of how the program works. And
  218. although I say this is a technical guide, it should really be read by
  219. everyone.
  220.  
  221. When WBM is run it looks for two things, (i) it's config file
  222. ("S:menu.dat"), and (ii) a brush file ("S:WBM.pic"), and loads them up,
  223. the final part of WBM that is not necessary, but for the less techie
  224. among you it's bloody useful, and that is the button Editor
  225. ("S:WBMEditor").
  226.  
  227.  
  228.  
  229. How Does It Work ?
  230. ~~~~~~~~~~~~~~~~~~
  231.  
  232.  
  233.  
  234. Well when you press a program button (or use F1->F6) WBM first checks
  235. whether the file exists, and if it does it either opens a 1x1 CLI at 0,0
  236. (top left hand corner), or a long thin bar at the top of the WorkBench
  237. screen, it then executes the instruction "BRun <command>", or if a stack
  238. was set "BRun -S<stack> <command>" via the CLI. (Yikes, there goes my one
  239. and only trade secret ! :^). That's why you *must* use the version of BRun
  240. that is supplied (and installed to C:) on the disk.
  241.  
  242. So if the program fails to load the CLI may stall be active, so move the
  243. mouse up to the top left hand corner and drag the CLI larger, then type
  244. `endcli', O/S 2+ owners should do a similar thing, but instead just click
  245. on the title bar, type `endcli' and that should close it.
  246.  
  247.  
  248.  
  249. Using WBM to launch WBM Ed
  250. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  251.  
  252.  
  253. To use WBM to run the editor program, WBM looks in S: for WBMEditor, and
  254. once you have quitted it reloads the config file, and redraws it's
  255. self.
  256.  
  257.  
  258.  
  259. MISC
  260. ~~~~
  261.  
  262. WBM also allows the use of keys to simulate mouse actions, so you don't
  263. have to go scrambling into your draw for a mouse.
  264.  
  265.  Keys used are :
  266.  
  267.  
  268.                 F1 -»> F6 - Buttons 1 to 6
  269.                 +/-       - +/- a set of buttons
  270.  
  271.  
  272. Programs for use with WBM *MUST* be CLI startable
  273.  
  274.  
  275.  
  276.                         WBM Editor
  277.                         ~~~~~~~~~~
  278.  
  279.  
  280. All though this program is not essential, that is the config file can be
  281. edited using a standard ASCII text editor (if you don't know what an ASCII
  282. text editor is then stick with WBM Ed !) as long as you know the following
  283. facts
  284.  
  285. 1st line contains WBM's startup orientation (i.e. Horizontal, Vertical or
  286. Iconifyed) which are 2,1 or 3 respectively.
  287.  
  288. The next two lines contain the x and y values (respectively) of WBM's
  289. vertical position.
  290.  
  291. The next four lines (and the next four after etc..) contain the actual
  292. buttons information, so here is an explanation of what each line
  293. contains:
  294.  
  295. (i)   the buttons label (10 chars max)
  296. (ii)  the command line for the button
  297. (iii) any change of directory WBM must perform (same as a DOS CD)
  298. (iv)  stack size  (max 5 chars) (see WorkBench manual)
  299.  
  300. Note : (iii) and (iv) are optional, and can be left blank if not needed
  301.  
  302. if in doubt see the example menu provided.
  303.  
  304.         As said in the help program, putting ` |END' on the end of your
  305. command line will cause WBM to quit after starting your program, thus
  306. freeing memory, useful for those of use who do not have obscene amounts of
  307. memory :^).
  308.  
  309. Also if you put ` |?' at the end of you command line, when that button
  310. is `pressed' WBM will bring up a requester asking for additional
  311. information to be entered. This is mostly useful for archivers such as
  312. Lha etc.. or text readers. Now when this occurs the following requestor
  313. appears :
  314.  
  315.         +---+---------------------------------------------------+
  316.         |_4_|                                                   |
  317.         |                                                       |
  318.         | Enter addition to command line here :                 |
  319.         | _____________________________________     _________   |
  320.         ||_________________1___________________|   |____2____|  |
  321.         |                                           _________   |
  322.         |                                          |____3____|  |
  323.         |                                                       |
  324.         +-------------------------------------------------------+
  325.  
  326.  
  327.          Where :
  328.  
  329.                 1. Is a text box containing your original command line
  330.                    (e.g. `lha a ' or `PPMore ')
  331.  
  332.                 2. Is the browse button that brings up a file requestor
  333.                    enabling you to chose a file/or just a path, this is
  334.                    inserted at the end of the command line each time
  335.                    you use it.
  336.  
  337.                 3. Is the button that executes the command line via a
  338.                    CLI window
  339.  
  340.                 4. Is the close-window gadget, this cancels the
  341.                    operation, exiting to WBM's main window.
  342.  
  343.  
  344. Also an important thing to note is that if the ` |?' param is used then
  345. the set stack option will have no effect.
  346.  
  347. See example menu provided for more details.
  348.  
  349.  
  350. Again use the help program to find out the general features, as well as
  351. that here are some additional notes.
  352.  
  353. Save
  354. ~~~~
  355. This saves ALL of the buttons information to the config file (not just
  356. that buttons information, OK Rob ?)
  357.  
  358. Clear
  359. ~~~~~
  360. This clears the current buttons information (quicker than using the
  361. delete key ! :^))
  362.  
  363. Browse
  364. ~~~~~~
  365. This Brings up a file-requester, so what you do is follow these simple
  366. instructions
  367.  
  368.         Click on drives and select the drive the program is on
  369.         Click though any draws you need to
  370.         Click on the file you want.
  371.         And finally press OK, and the information will be inserted into
  372.         the command line box.
  373.  
  374.  
  375.  
  376.                         Important Note !
  377.                         ~~~~~~~~~~~~~~~~
  378.  
  379.  
  380.  
  381. To use split names, such as `RAM DISK:' or `My Disk:', use double quotes,
  382.  
  383.         So
  384.  
  385.                 Command Line :
  386.  
  387.                 WorkBench 2.x:Games/MyGame/MyGame
  388.  
  389.  
  390.         Becomes
  391.  
  392.  
  393.                 Command Line :
  394.  
  395.                 "WorkBench 2.x:Games/MyGame/Mygame"
  396.  
  397.  
  398. This process should also be used if the draw/directory or even if the target
  399. program its self has a split name :
  400.  
  401.  
  402.  
  403.         So
  404.  
  405.                 Command Line :
  406.  
  407.                 Disk:Games/My Game/Start Game
  408.  
  409.  
  410.  
  411.         Becomes
  412.  
  413.  
  414.                 Command Line :
  415.  
  416.                 "Disk:Games/My Game/Start Game"
  417.  
  418.  
  419. And finally the last example is...
  420.  
  421.  
  422.                 Command Line :
  423.  
  424.                 C:More My Disk:My Draw/My File
  425.  
  426.  
  427.         Becomes
  428.  
  429.                 Command Line :
  430.  
  431.                 C:More "My Disk:My Draw/My File"
  432.  
  433.  
  434.  
  435. So the general rule is if one of the components (be it drive/directory or
  436. file) has a split name (E.G. 'RAM DISK:'/'MY DRAW'/'MY FILE'), put a quote
  437. at the very start and very end of the command line (or change directory line
  438. if it was required.)
  439.  
  440.  
  441.  
  442.  
  443. Also another thing I must mention, that will mainly of use with games, but
  444. also with a few utilities that expect data files to be in the current
  445. directory, is the use of the 'Change Current Dir' feature. you may need to
  446. change this if you chosen game/util doesn't work to the path chosen in your
  447. command line. A good way to spot if a game/util requires this function, is
  448. to look out for any extra files in the dir, for example :
  449.  
  450.  
  451.  
  452.         SYS:Games/Syndicate     } this is the path to use.
  453.                 Synd         \
  454.                 Intro         \
  455.                 Go             }--- If the game has lots of files in it's
  456.                 map1.dat      /     dir then it probably requires this
  457.                 ply          /      function.
  458.  
  459.  
  460.         or
  461.  
  462.  
  463.         Sys:Utils/Nib
  464.                 [NibData] \
  465.                 [Sounds]   }- If you spot other directories, then you will
  466.                 [Prams]   /   have to use the function.
  467.                 Nib.info  \
  468.                 Nib        }- Don't worry about .info files, they are only
  469.                 Nib.dat   /   used by Workbench as icon files, but take
  470.                               note of the .dat file.
  471.  
  472.  
  473. Another thing to spot is if the game fails to load, a classic example is
  474. Syndicate, using Workbench you click on an icon called GO, which is in fact
  475. a script file (i.e. it is executed by workbench via a command called
  476. IconX). in turn using WBM we must also Execute it, so the command line used
  477. may be some thing like this :
  478.  
  479.                 Execute SYS:Games/Syndicate/GO
  480.  
  481. The way you can find out if a file is actually a script file, is to use the
  482. Workbench menu option 'Info..', and if the default tool is set to IconX,
  483. then the file is a script file.
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.                         Shareware Registration
  492.                         ~~~~~~~~~~~~~~~~~~~~~~
  493.  
  494.         As mentioned in my program, in the about requester, what you
  495. have in your little hands is the FULL (as in not crippled) version of
  496. WBM, this is supplied FREE OF CHARGE, with the sole understanding, that
  497. if you intend to use it for more than 3 weeks, you should register the
  498. program by sending a fee of five pounds (£5) sterling to the address
  499. specified at the end of this doc file. Now I am trusting that you lot
  500. will of course abide by this, and that little voice inside of you
  501. called a conscience will see to it that you do pay up !
  502.  
  503.         On a serious note though, I could have crippled the program in
  504. some way before I distributed it, but unfortunately for me (and you
  505. ultimately) I am in fact in the process of selling my Amiga to upgrade
  506. to a nice 486 DX PC (running at 33 MHz with 8 Meg of RAM, 200 Meg hard
  507. drive, SVGA graphics card, and SoundBlaster Pro Sound Board). So I had
  508. no way to produce unique updates for registered versions, and
  509. consequently no alternative, but to trust you lot and release the full
  510. un-crippled version (wise move it may not be, but hey ! Prove me
  511. wrong).
  512.  
  513.  
  514.  
  515. Ego (Sorry Credits) And Jovial Comments Section
  516. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  517.  
  518. Coding & Design      : Andy "Expression Too Complex" O'Connell
  519.  
  520. Ideas & Beta Testing : Rob "Kumquat" Humphreys
  521.  
  522. General Annoyance    : Mark "Mines A Pint" Wilkins
  523.  
  524. The above is also responsible for being too #*!?$ good at
  525. "Archer Maclean's Pool" (not that I'm bitter by the way :^)
  526.  
  527.  
  528. As with all great programmers (Ahem), lessening to music often helps relieve
  529. the intense boredom of bashing hell out of a computer, and coming out with
  530. superb/mind blowing/outstanding (delete as appropriate) pieces of software
  531. like this !. :^)
  532.  
  533.  
  534.  
  535. Inspirational listening
  536. ~~~~~~~~~~~~~~~~~~~~~~~
  537. (No particular order)
  538.  
  539. One Dove - Morning Dove White (track 3 especially)
  540. Bjork - Debut (Chaaaaannnnnnn)
  541. Mariah Cary - Music Box
  542. R.E.M. - Automatic For The People
  543. Mica Paris - Whisper A Prayer
  544. Sade - Love Deluxe
  545. D:Ream - D:Ream On Vol 1
  546. Moby - The Story So Far (Aaarrrd Korrre :^) )
  547. Orbital - Untitled (or the one with Lush 3 on)
  548. M People - Elegant Slumming
  549. Ministry Of Sound - The Sessions Vol 1
  550. Sunscream - 0³ (Under Pressure....Whoooa Whoooa :^) )
  551. Jesus Jones - Perverse (0's and 1's will take us there....)
  552. The Orb - The Orb's Adventures Beyond Ultraworld
  553. Ministry Of Sound - The Sessions Vol 2
  554. Moby - Move EP
  555. Stereo MC's - Connected
  556. The Cranberries - Everybody Else Is Doing It, So Why Cant We ?
  557. Nirvana - Nevermind
  558. Shara Nelson - What Silence Knows (One Good Bye In Tennnnnnn !)
  559.  
  560.  
  561. They are excellent albums and I would recommend them to any one (Except
  562. Rob, but then again Rob likes Meat Loaf :^) ).
  563.  
  564. Right well I'm off down the pub now so I'll leave my address, so if you
  565. want to send registration fee's, ideas, or you would just like a
  566. programmers chat (What I would welcome is response from other Blitz 2
  567. users.)
  568.  
  569.  
  570.                 Andrew O'Connell
  571.                 10 London Road
  572.                 Tetbury
  573.                 Glos.
  574.                 GL8 8JL
  575.                 ENGLAND
  576.  
  577.  
  578.  
  579. Copyright
  580. ~~~~~~~~~
  581.  
  582. WorkBenchMate (WBM), And all its components is © Copyright 1994 by
  583. Andrew O'Connell  All Rights Reserved
  584.  
  585. This program is sold `AS IS'
  586.  
  587. Therefore the user does so at his/her own risk, There is NO liability or
  588. responsibility for any damage the program may cause.
  589.  
  590. WBM can be freely distributed, as long as all ShareWare and Copyright
  591. notices are left intact (thankyouverymuch)
  592.  
  593. Syndicate is © 1993 Virgin Games Ltd
  594. NIB is © 1990 Shawn Liptak
  595. CanDO is © INOVAtronics Inc
  596.  
  597.  
  598.  
  599.  
  600.